ExportHelper.exportImage Method

Export current view to image.

This method is static.

Parameters

imageOptions

Type: Object

(optional) An object literal with the default values for the following properties:                        
     appendDateToFileName    [type: bool]                            - Value indicating whether or not the date should be appended to the export filename.
     overrideFileName        [type: String]                          - The filename to be used for the exported file rather than the system generated name.
     openOnCompletion        [type: bool]                            - Value indicating whether or not the export file should be opened/downloaded when ready.
     enableOverlay           [type: bool]                            - Value indicating whether or not an overlay should be shown while export is taking place.            
     selection               [type: dundas.export.ExportSelection]   - Value indicating what will be exported to image.  Must be one of the following: Entire View or Single Item.
     adapterId               [type: String]                          - The ID of the adapter to be exported to an image.  Can only be used if selection is set to Single Item.
     view                    [type: dundas.entities.View, optional]  - View to export.  If not specified the current parent view will be exported.

Optional: True

Return Value

Type: jQuery.Promise
Value: String
A promise object that is resolved when the call is complete. If successful, a String is returned with the URL of the export.